mock: document public APIs in the field module
#2443
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change adds documentation to the `field` module and all the public APIs within it. This includes doctests on all the methods which serve as examples. Additionally, the `field::msg` function (which constructs a field with name "message" and the provided value) was moved to `expect::message`. This is part of a unification of all expectation constructors inside the `expect` module. Refs: #539
Was previously `field::msg`.
davidbarsky
requested changes
Oct 28, 2023
tracing-mock/src/field.rs
Outdated
Comment on lines
291
to
292
| /// If we include `only` on the `ExpectedField` then the test | ||
| /// will fail: |
There was a problem hiding this comment.
Suggested change
| /// If we include `only` on the `ExpectedField` then the test | |
| /// will fail: | |
| /// The following example fails because [`ExpectedField::only`] is called: |
There was a problem hiding this comment.
I worded this a bit differently because the difference between the 2 examples is now that the second example records an additional field.
Co-authored-by: David Barsky <me@davidbarsky.com>
Co-authored-by: David Barsky <me@davidbarsky.com>
hds
commented
Oct 31, 2023
There was a problem hiding this comment.
@davidbarsky I've added your changes and made the suggested changes to the docs for only().
There was just one place in the only() docs where I felt that they didn't fit. Please let me know what you think.
tracing-mock/src/field.rs
Outdated
Comment on lines
291
to
292
| /// If we include `only` on the `ExpectedField` then the test | ||
| /// will fail: |
There was a problem hiding this comment.
I worded this a bit differently because the difference between the 2 examples is now that the second example records an additional field.
davidbarsky
approved these changes
Nov 13, 2023
hds
added a commit
that referenced
this pull request
Nov 5, 2024
This change adds documentation to the tracing-mock `field` module and all the public APIs within it. This includes doctests on all the methods which serve as examples. Additionally, the `field::msg` function (which constructs a field with name "message" and the provided value) was moved to `expect::message`. This is part of a unification of all expectation constructors inside the `expect` module. Refs: #539 Co-authored-by: David Barsky <me@davidbarsky.com>
hds
added a commit
that referenced
this pull request
Nov 5, 2024
This change adds documentation to the tracing-mock `field` module and all the public APIs within it. This includes doctests on all the methods which serve as examples. Additionally, the `field::msg` function (which constructs a field with name "message" and the provided value) was moved to `expect::message`. This is part of a unification of all expectation constructors inside the `expect` module. Refs: #539 Co-authored-by: David Barsky <me@davidbarsky.com>
hds
added a commit
that referenced
this pull request
Nov 7, 2024
This change adds documentation to the tracing-mock `field` module and all the public APIs within it. This includes doctests on all the methods which serve as examples. Additionally, the `field::msg` function (which constructs a field with name "message" and the provided value) was moved to `expect::message`. This is part of a unification of all expectation constructors inside the `expect` module. Refs: #539 Co-authored-by: David Barsky <me@davidbarsky.com>
hds
added a commit
that referenced
this pull request
Nov 7, 2024
This change adds documentation to the tracing-mock `field` module and all the public APIs within it. This includes doctests on all the methods which serve as examples. Additionally, the `field::msg` function (which constructs a field with name "message" and the provided value) was moved to `expect::message`. This is part of a unification of all expectation constructors inside the `expect` module. Refs: #539 Co-authored-by: David Barsky <me@davidbarsky.com>
hds
added a commit
that referenced
this pull request
Nov 20, 2024
This change adds documentation to the tracing-mock `field` module and all the public APIs within it. This includes doctests on all the methods which serve as examples. Additionally, the `field::msg` function (which constructs a field with name "message" and the provided value) was moved to `expect::message`. This is part of a unification of all expectation constructors inside the `expect` module. Refs: #539 Co-authored-by: David Barsky <me@davidbarsky.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
There has been interest around publishing tracing-mock to crates.io
for some time. In order to make this possible, documentation and some
code clean up is needed.
The
fieldmodule needs documentation and examples.Solution
This change adds documentation to the
fieldmodule and all the publicAPIs within it. This includes doctests on all the methods which serve as
examples.
Additionally, the
field::msgfunction (which constructs a field withname "message" and the provided value) was moved to
expect::message.This is part of a unification of all expectation constructors inside the
expectmodule.Refs: #539